home *** CD-ROM | disk | FTP | other *** search
/ The PC-SIG Library 10 / The PC-Sig Library - Shareware for the IBM PC and Compatibles (PC-SIG)(Tenth Edition Disks 1-2804)(1991).iso / PC_SIGCD / 19 / 5 / DISK1959.ZIP / QB4CREF.DOC < prev    next >
Text File  |  1989-07-23  |  10KB  |  190 lines
  1.  
  2.     
  3.                              DOCUMENTATION FOR QB4CREF
  4.     
  5.                                    INTRODUCTION
  6.         QB4CREF is a cross-reference program for Quick BASIC programs.  It will 
  7.     cross-reference even interpreted BASIC (GWBASIC) programs, but the 
  8.     reference information will not be as useful as for Quick BASIC programs.
  9.         QB4CREF is copyrighted (c), 1989, by T.N.T. Software Inc.  It was 
  10.     written by Bruce W. Tonkin.  It is a shareware program: that means you may 
  11.     try it before you buy it.  If you try it and decide you like it and wish to 
  12.     continue using it, you should register your copy by sending $25 to T.N.T. 
  13.     Software Inc. at 34069 Hainesville Road, Round Lake IL 60073.  Registered 
  14.     users are entitled to support and source code, and will be notified of any 
  15.     updates.
  16.         You may freely distribute QB4CREF to your friends and you may post it 
  17.     on bulletin boards and the like.  You may not sell QB4CREF without the 
  18.     written permission of T.N.T. Software Inc.
  19.     
  20.                                   RUNNING QB4CREF
  21.         QB4CREF is very easy to run.  If you don't remember how to use it, just 
  22.     type in QB4CREF at the MSDOS command line and the program itself will tell 
  23.     you what to do.
  24.         The normal syntax is:
  25.     QB4CREF INFILE OUTFILE
  26.         Where INFILE is the name of the input file, and OUTFILE is the name of 
  27.     the desired output file.  INFILE should be a BASIC program saved as a text 
  28.     file, and OUTFILE may be a disk file or a device name (such as LPT1, PRN, 
  29.     or COM1).  If you don't give a file type extension for INFILE, QB4CREF will 
  30.     assume the file name ends in .BAS.  There is no default extension for the 
  31.     output file.  If you don't give an output file name, the cross-reference 
  32.     information will be displayed on the screen.
  33.         QB4CREF will not check to see if the output file already exists.  If it 
  34.     does, it will be overwritten.  If you give the same name for the input and 
  35.     output files, QB4CREF will crash--stop running, give an error message, and 
  36.     return to MSDOS.
  37.         As QB4CREF runs, it will display information for you on the screen.  
  38.     The information will be much the same as the information written to the 
  39.     output file.
  40.     
  41.                                       LIMITS
  42.         QB4CREF can handle up to 1,000 variables, 1,000 labels, 1,000 
  43.     subprograms, and 1,000 functions (up to 4,000 items in total).  The 
  44.     variable names may be of any length, but for the others only the first 32 
  45.     characters will be significant.  That's unlikely to cause any problem; 
  46.     names longer than 32 characters rarely happen, and in nearly every case the 
  47.     name differs from another name by then.
  48.         QB4CREF will recognize every keyword present in Quick BASIC 4.5.  It 
  49.     will be easy to add more keywords as future versions of Quick BASIC are 
  50.     released.
  51.         All references for the various items will be by the relative line 
  52.     number in the source code.  The line numbers (if any) present in the 
  53.     original source code will be treated as the labels they are.  'Include 
  54.     files' will not be included in the cross-reference.  To do so would make 
  55.     line number referencing rather difficult.
  56.     
  57.                          APPEARANCE OF THE CROSS-REFERENCE
  58.         Rather than attempt to describe what a cross-reference looks like, I 
  59.     will show you what the cross-reference for QB4CREF looks like:
  60.     
  61.  
  62.  
  63.                                           1
  64.  
  65.     
  66.     Cross reference for qb4cref.bas as of 14:28:50 on 07-23-1989
  67.      415 lines, and 14762 bytes.
  68.     
  69.      1 subprograms defined:
  70.     Name                             Line
  71.     wipe                             405
  72.     
  73.      1 labels used and referenced:
  74.     premature
  75.     
  76.      45 variables, subprograms, and labels used:
  77.     a           f$          islegal$    maxlen      subcount    wipe
  78.     a$          flag        j           minlen      subs(       x
  79.     a$(         fmt$        k           offset      t!          x$
  80.     b           fsize&      keywords    outlin      top         z
  81.     b$          funcount    labelcount  poscount    v$(         z$
  82.     c$          funs(       labels(     premature   varcount
  83.     columns     i           lastrow     q$          what
  84.     conprint    isdigit$    maxlabel    sp          where
  85.     
  86.     Variable/label/function/subprogram reference by source line:
  87.     a..........   2  64  65  78  79  80  82  83  87  88  89  90  91  93  94  95
  88.                  99 100 101 102 106 107 108 109 116 117 118 119 125 127 128 129
  89.                 140 142 143 147 148 149 160 162 163 169 170 171 182 184 185 186
  90.                 197 203 204 205 206 207 209 210 212 237 238 239 240 251 253 254
  91.                 257 260 380 381 408 410 411 412
  92.     a$.........  74  76  77  78  80  81  82  83  85  87  88  90  93  95  96  97
  93.                  99 101 102 104 105 114 115 124 125 126 127 128 146 147 148 166
  94.                 169 171 182 184 186 197 199 203 205 206 207 208 209 210 212 216
  95.                 218 221 226 230 232 233 246 248 249 250 255 261 262 265 266 268
  96.                 362 379 380 406 408 411 412
  97.     a$(........   5  49  50  52 200 203 206 207 209 210 212
  98.     b..........  80  81  82
  99.     b$.........  90  91 128 130 131 132 140 141 142 143 148 150 151 152 160 161
  100.                 162 163 171 172 173 174 186 187 188 189 222 223 224 225 226 228
  101.                 248 250 377 380
  102.     c$.........  65  66 243 299
  103.     columns.... 334 335 337 340 341 349 350 352 355 356
  104.     conprint... 243 273 275 302 310 312 315 321 323 326 331 341 344 346 347 356
  105.                 359 361 363 365 375 385 389 393 397
  106.     f$.........  53  54  64  65  67  68 300 303
  107.     flag....... 132 134 136 152 154 156 174 176 178 189 191 193 254 255 256 257
  108.                 260 261 262 263 264 265 280 282 287 289 294 296 376 383 390
  109.     fmt$....... 370 371 388 389
  110.     fsize&.....  68 301 304
  111.     funcount... 120 121 122 291 318 320 321 324
  112.     funs(......  13 121 122 294 325 326
  113.     i..........  49  50  52 130 131 132 140 150 151 152 160 172 173 174 187 188
  114.                 189 202 203 206 207 209 210 212 215 264 279 280 281 286 287 288
  115.                 293 294 295 313 314 315 316 324 325 326 327 336 338 345 351 353
  116.                 360 366 367 368 372 374 375 377 399
  117.     isdigit$...  14  15
  118.     islegal$...  15  88  91 131 151 173 188 205 206
  119.     j.......... 133 134 135 153 154 155 175 176 177 190 191 192 337 338 340 341
  120.                 343 352 353 355 356 358 378 388 389 396
  121.     k.......... 338 339 340 341 353 354 355 356
  122.     keywords...  52 200 202
  123.     labelcount.  72 132 133 134 137 138 152 153 154 157 158 174 175 176 179 180
  124.  
  125.  
  126.                                           2
  127.  
  128.     
  129.                 189 190 191 194 195 276 277 330 332 335 339
  130.     labels(....   7 132 134 138 152 154 158 174 176 180 189 191 195 280 340 341
  131.     lastrow.... 335 336 338 350 351 353
  132.     maxlabel... 138 158 180 195 334
  133.     maxlen..... 268 349 371 391
  134.     minlen..... 200 208
  135.     offset..... 367 369 371 374 375 384 385
  136.     outlin..... 112 122 233 301 304 370 378
  137.     poscount... 376 382 390 391 392 397
  138.     premature..  77  96 124 126 146 166 216 231
  139.     q$.........  71 218
  140.     sp.........   8  12  13
  141.     subcount... 110 111 112 284 307 309 310 313
  142.     subs(......  12 111 112 287 314 315
  143.     t!.........   3 401
  144.     top........ 277 278 279 282 284 285 286 289 291 292 293 296
  145.     v$(........   6 255 261 262 264 265 355 356 367 374 375 377
  146.     varcount... 244 251 261 264 267 347 348 350 354 366 372
  147.     what.......   9 111 121 287 294 314 315 325 326
  148.     where......  10 112 122 314 315 325 326
  149.     wipe.......   1  86 167 168 217 405
  150.     x.......... 130 131 150 151 172 173 187 188 252 253 254 256 260 409 411
  151.     x$.........  75 105 106 107 108 109 111 115 116 117 118 119 121 201 247 373
  152.     z..........   2
  153.     z$.........   1 405 408 409 412
  154.     
  155.         This particular program used no functions.  It it had, the functions 
  156.     would also have been referenced just after the sub-programs.
  157.         The line numbers referenced are lined up to match the longest variable 
  158.     name, label, subprogram, or function name.  The line numbers themselves are 
  159.     formatted to allow one space between each line number for the largest line 
  160.     number appearing in the program.  Those two rules assure that all line 
  161.     numbers and names will line up when printed.  The printed lines will always 
  162.     fit on a standard 80-column page.
  163.     
  164.                                      THE END?
  165.         This isn't the end if you don't want it to be.  QB4CREF can get better, 
  166.     if you register and tell me what more you'd like to see.  I do listen to 
  167.     users; if I have none, I've just wasted my time.  If I have some, and I 
  168.     don't listen, soon enough I won't have any.
  169.         It's better if you write me.  I'm at the office fairly often, but I'm 
  170.     usually working hard and writing software.  It's less of an interruption to 
  171.     read the mail.  Still, if it's an emergency you can call.  If I'm there, 
  172.     I'm always willing to talk to registered users.
  173.         I've written a lot of other programs, too.  Even if you're not a 
  174.     registered user, I'd be happy to send you a free catalog.  Write or call:
  175.     
  176.                                T.N.T. Software, Inc.
  177.                                Attn: Bruce W. Tonkin
  178.                                34069 Hainesville Rd.
  179.                                 Round Lake IL 60073
  180.                                   (312) 223-8595
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.                                           3
  190.